/**
 * Copyright © 2016-2025 The Thingsboard Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.terracloud.server.service.device;

import com.terracloud.server.common.data.device.DeviceAccessControlMode;
import com.terracloud.server.common.data.device.DeviceAccessControlRule;
import com.terracloud.server.common.data.id.DeviceAccessControlRuleId;
import com.terracloud.server.common.data.id.TenantId;
import com.terracloud.server.common.data.page.PageData;
import com.terracloud.server.common.data.page.PageLink;
import com.terracloud.server.common.data.security.DeviceCredentialsFilter;
import com.terracloud.server.common.transport.auth.DeviceAuthResult;

public interface DeviceAccessControlService {

    /**
     * 保存设备接入控制规则
     *
     * @param tenantId 租户ID
     * @param rule     设备接入控制规则实体
     * @return 保存后的设备接入控制规则实体
     */
    DeviceAccessControlRule saveDeviceAccessControlRule(TenantId tenantId, DeviceAccessControlRule rule);

    /**
     * 根据ID查找设备接入控制规则
     *
     * @param tenantId 租户ID
     * @param ruleId   设备接入控制规则ID
     * @return 设备接入控制规则实体
     */
    DeviceAccessControlRule findDeviceAccessControlRuleById(TenantId tenantId, DeviceAccessControlRuleId ruleId);

    /**
     * 查找所有设备接入控制规则列表
     *
     * @param pageLink 分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findAllDeviceAccessControlRules(PageLink pageLink);

    /**
     * 根据文本搜索查找所有设备接入控制规则列表
     *
     * @param textSearch 文本搜索关键字
     * @param pageLink   分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByTextSearch(String textSearch, PageLink pageLink);

    /**
     * 根据规则类型和文本搜索查找所有设备接入控制规则列表
     *
     * @param type       规则类型
     * @param textSearch 文本搜索关键字
     * @param pageLink   分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByTypeAndTextSearch(String type, String textSearch, PageLink pageLink);

    /**
     * 根据访问控制模式和文本搜索查找所有设备接入控制规则列表
     *
     * @param mode       访问控制模式
     * @param textSearch 文本搜索关键字
     * @param pageLink   分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByModeAndTextSearch(DeviceAccessControlMode mode, String textSearch, PageLink pageLink);

    /**
     * 根据规则类型、访问控制模式和文本搜索查找所有设备接入控制规则列表
     *
     * @param type       规则类型
     * @param mode       访问控制模式
     * @param textSearch 文本搜索关键字
     * @param pageLink   分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByTypeAndModeAndTextSearch(String type, DeviceAccessControlMode mode, String textSearch, PageLink pageLink);

    /**
     * 根据规则类型查找所有设备接入控制规则列表
     *
     * @param type     规则类型
     * @param pageLink 分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByType(String type, PageLink pageLink);

    /**
     * 根据访问控制模式查找所有设备接入控制规则列表
     *
     * @param mode     访问控制模式
     * @param pageLink 分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByMode(DeviceAccessControlMode mode, PageLink pageLink);

    /**
     * 根据规则类型和访问控制模式查找所有设备接入控制规则列表
     *
     * @param type     规则类型
     * @param mode     访问控制模式
     * @param pageLink 分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByTypeAndMode(String type, DeviceAccessControlMode mode, PageLink pageLink);

    /**
     * 查找租户的设备接入控制规则列表
     *
     * @param tenantId 租户ID
     * @param pageLink 分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRules(TenantId tenantId, PageLink pageLink);

    /**
     * 根据规则类型查找租户的设备接入控制规则列表
     *
     * @param tenantId 租户ID
     * @param type     规则类型
     * @param pageLink 分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByType(TenantId tenantId, String type, PageLink pageLink);

    /**
     * 根据访问控制模式查找租户的设备接入控制规则列表
     *
     * @param tenantId 租户ID
     * @param mode     访问控制模式
     * @param pageLink 分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByMode(TenantId tenantId, DeviceAccessControlMode mode, PageLink pageLink);

    /**
     * 根据规则类型和访问控制模式查找租户的设备接入控制规则列表
     *
     * @param tenantId 租户ID
     * @param type     规则类型
     * @param mode     访问控制模式
     * @param pageLink 分页参数
     * @return 设备接入控制规则分页数据
     */
    PageData<DeviceAccessControlRule> findDeviceAccessControlRulesByTypeAndMode(TenantId tenantId, String type, DeviceAccessControlMode mode, PageLink pageLink);

    /**
     * 删除设备接入控制规则
     *
     * @param tenantId 租户ID
     * @param ruleId   设备接入控制规则ID
     */
    void deleteDeviceAccessControlRule(TenantId tenantId, DeviceAccessControlRuleId ruleId);

    /**
     * 获取设备接入控制模式
     *
     * @param tenantId 租户ID
     * @return 设备接入控制模式
     */
    DeviceAccessControlMode getAccessControlMode(TenantId tenantId);

    /**
     * 设置设备接入控制模式
     *
     * @param tenantId 租户ID
     * @param mode     设备接入控制模式
     */
    void setAccessControlMode(TenantId tenantId, DeviceAccessControlMode mode);

    /**
     * 验证设备是否可以接入系统
     *
     * @param tenantId  租户ID
     * @param deviceId  设备ID
     * @param deviceCredentials 设备凭证
     * @param clientAddress 客户端地址
     * @return 设备认证结果
     */
    DeviceAuthResult checkAccess(TenantId tenantId, String deviceId, DeviceCredentialsFilter deviceCredentials, String clientAddress);
}